.\"     Title: \fBndb_waiter\fR
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
.\"      Date: 03/31/2009
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.1
.\"
.TH "\fBNDB_WAITER\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
ndb_waiter \- wait for MySQL Cluster to reach a given status
.SH "SYNOPSIS"
.HP 19
\fBndb_waiter \fR\fB\fIoptions\fR\fR
.SH "DESCRIPTION"
.PP
\fBndb_waiter\fR
repeatedly (each 100 milliseconds) prints out the status of all cluster data nodes until either the cluster reaches a given status or the
\fB\-\-timeout\fR
limit is exceeded, then exits. By default, it waits for the cluster to achieve
STARTED
status, in which all nodes have started and connected to the cluster. This can be overridden using the
\fB\-\-no\-contact\fR
and
\fB\-\-not\-started\fR
options (see
Additional Options).
.PP
The node states reported by this utility are as follows:
.TP 3n
\(bu
NO_CONTACT: The node cannot be contacted.
.TP 3n
\(bu
UNKNOWN: The node can be contacted, but its status is not yet known. Usually, this means that the node has received a
START
or
RESTART
command from the management server, but has not yet acted on it.
.TP 3n
\(bu
NOT_STARTED: The node has stopped, but remains in contact with the cluster. This is seen when restarting the node using the management client's
RESTART
command.
.TP 3n
\(bu
STARTING: The node's
\fBndbd\fR
process has started, but the node has not yet joined the cluster.
.TP 3n
\(bu
STARTED: The node is operational, and has joined the cluster.
.TP 3n
\(bu
SHUTTING_DOWN: The node is shutting down.
.TP 3n
\(bu
SINGLE USER MODE: This is shown for all cluster data nodes when the cluster is in single user mode.
.sp
.RE
.PP
\fBUsage\fR:
.sp
.RS 3n
.nf
ndb_waiter [\-c \fIconnect_string\fR]
.fi
.RE
.PP
\fBAdditional Options\fR:
.TP 3n
\(bu
\fB\-\-no\-contact\fR,
\fB\-n\fR
.sp
Instead of waiting for the
STARTED
state,
\fBndb_waiter\fR
continues running until the cluster reaches
NO_CONTACT
status before exiting.
.TP 3n
\(bu
\fB\-\-not\-started\fR
.sp
Instead of waiting for the
STARTED
state,
\fBndb_waiter\fR
continues running until the cluster reaches
NOT_STARTED
status before exiting.
.TP 3n
\(bu
\fB\-\-timeout=\fR\fB\fIseconds\fR\fR,
\fB\-t \fR\fB\fIseconds\fR\fR
.sp
Time to wait. The program exits if the desired state is not achieved within this number of seconds. The default is 120 seconds (1200 reporting cycles).
.sp
.RE
.PP
\fBSample Output\fR. Shown here is the output from
\fBndb_waiter\fR
when run against a 4\-node cluster in which two nodes have been shut down and then started again manually. Duplicate reports (indicated by
\(lq...\(rq) are omitted.
.sp
.RS 3n
.nf
shell> \fB./ndb_waiter \-c localhost\fR
Connecting to mgmsrv at (localhost)
State node 1 STARTED
State node 2 NO_CONTACT
State node 3 STARTED
State node 4 NO_CONTACT
Waiting for cluster enter state STARTED
...
State node 1 STARTED
State node 2 UNKNOWN
State node 3 STARTED
State node 4 NO_CONTACT
Waiting for cluster enter state STARTED
...
State node 1 STARTED
State node 2 STARTING
State node 3 STARTED
State node 4 NO_CONTACT
Waiting for cluster enter state STARTED
...
State node 1 STARTED
State node 2 STARTING
State node 3 STARTED
State node 4 UNKNOWN
Waiting for cluster enter state STARTED
...
State node 1 STARTED
State node 2 STARTING
State node 3 STARTED
State node 4 STARTING
Waiting for cluster enter state STARTED
...
State node 1 STARTED
State node 2 STARTED
State node 3 STARTED
State node 4 STARTING
Waiting for cluster enter state STARTED
...
State node 1 STARTED
State node 2 STARTED
State node 3 STARTED
State node 4 STARTED
Waiting for cluster enter state STARTED
NDBT_ProgramExit: 0 \- OK
.fi
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
\fBNote\fR
.PP
If no connectstring is specified, then
\fBndb_waiter\fR
tries to connect to a management on
localhost, and reports
Connecting to mgmsrv at (null).
.SH "COPYRIGHT"
.PP
Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/.
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
MySQL AB (http://www.mysql.com/).
